package com.zyinhao.swagger;

/**
 * Created by zhangyinhao on 2018/8/13
 * Description：
 */

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


/**
 * Swagger2配置类
 * 在与spring boot集成时，放在与Application.java同级的目录下。
 * 通过@Configuration注解，让Spring来加载该类配置。
 * 再通过@EnableSwagger2注解来启用Swagger2。
 *
 * http://localhost:9002/swagger-ui.html
 * http://localhost:9002/v2/api-docs
 */
@Configuration
@EnableSwagger2
public class Swagger2 {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zyinhao.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("使用Swagger2构建RESTful APIs")
                .description("更多请关注https://gitee.com/zyinhao/maventest02")
//                .termsOfServiceUrl("https://gitee.com/zyinhao/maventest02")
                .version("1.0")
                .build();
    }

}

/**
 * Swagger使用的注解及其说明：
 @Api：用在类上，说明该类的作用。
 @ApiOperation：注解来给API增加方法说明。
 @ApiImplicitParams : 用在方法上包含一组参数说明。
 @ApiImplicitParam：用来注解来给方法入参增加说明。
 @ApiResponses：用于表示一组响应
 @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
 code：数字，例如400
 message：信息，例如"请求参数没填好"
 response：抛出异常的类
 @ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）
 @ApiModelProperty：描述一个model的属性
 @ApiImplicitParam的参数说明：
 paramType：指定参数放在哪个地方:
     header：请求参数放置于Request Header，使用@RequestHeader获取
     query：请求参数放置于请求地址，使用@RequestParam获取
     path：（用于restful接口）-->请求参数的获取：@PathVariable
     body：（不常用）
     form（不常用）
 name：参数名
 dataType：参数类型
 required：参数是否必须传
 value：说明参数的意思
 defaultValue：参数的默认值
 */